<!DOCTYPE html>
<html lang="en">
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta charset="utf-8">
    <title>Parts Api Documentation</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="description" content="">
    <link href="help/css/bootstrap.css" rel="stylesheet">
    <link href="help/css/custom.css" rel="stylesheet">
    <link href="help/css/prettify.css" rel="stylesheet">
    <link href="help/css/bootstrap-responsive.css" rel="stylesheet">
    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="help/ico/apple-touch-icon-144-precomposed.png">
    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="help/ico/apple-touch-icon-114-precomposed.png">
    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="help/ico/apple-touch-icon-72-precomposed.png">
    <link rel="apple-touch-icon-precomposed" href="help/ico/apple-touch-icon-57-precomposed.png">
    <link rel="shortcut icon" href="help/ico/favicon.png">
    <style type="text/css"></style>
</head>

<body>

<div class="container-narrow">
    <h3 class="page-header">Parts Api Documentation</h3>

    <div class="hero-unit">
        <h1>Super awesome documentation!</h1>
    </div>

    <hr>

    <div>
        <ul id="actionTab" class="nav nav-tabs">
            <li class="active"><a href="#global" data-toggle="tab">Global</a></li>
            <li class=""><a href="#subfolder" data-toggle="tab">subfolder</a></li>
        </ul>
        <div class="tab-content">
            <div class="tab-pane fade active in" id="global">
                <div class="row-fluid">
                   <div class="span12">
                       <h2>Action</h2>
                       <p>Name: <span class="label label-info">ParserImport</span></p>
                       <p>Description: <span class="label label-info">A basic test action</span></p>
                       <p>Permissions: <span class="label label-info">CREATE_PLAYLIST</span></p>
                       Parameters:
                       <table class="table table-bordered table-hover table-striped">
                           <tr>
                               <th>Name</th>
                               <th>Type</th>
                               <th>Values</th>
                           </tr>
                           <tr>
                               <td>actionName</td>
                               <td>String</td>
                               <td>ParserImport</td>
                           </tr>
                           <tr>
                               <td>userName</td>
                               <td>String</td>
                               <td></td>
                           </tr>
                           <tr>
                               <td>passHash</td>
                               <td>String</td>
                               <td>SHA512HEX Hash of the user password</td>
                           </tr>
                       </table>
                       <h3>Request:</h3>
                        <pre>{
    actionName : ParserImport
    userName : user
    passHash : 6c1fe0650107843f91e5040409283b094f760fa258dadae221579803493a188a5b6b44510cd1a4e2cd3b749a0a4696642f60bec8fc8bc640953417f3463ba0e9
    }</pre>
                       <h3>Responses:</h3>
                       <h4>Response if login was successful</h4>
                        <pre>{
    type : OK
    sessionID : 3b409e60-83eb-11e2-9e96-0800200c9a66
    }</pre>
                       <h4>Response with all permissions</h4>
                        <pre>{
    type : OK
    oneList : {CREATE_PLAYLIST, MODIFY_PLAYLIST}
    }</pre>
                       <h4>Error response</h4>
                        <pre>{
    type : Error
    message.key : a error key
    message : a error message
    }</pre>
                       <h4>Returned when no connection to the database is available</h4>
                        <pre>{
    type : Error
    message.key : DatabaseError
    message : could not connect to database ...
    }</pre>
                       <h4>Returned when the id is already taken</h4>
                        <pre>{
    type : Error
    message.key : DuplicationError
    message : ID already taken
    }</pre>
                   </div>
                </div>
                <div class="row-fluid">
                    <div class="span12">
                        <h2>Action</h2>
                        <p>Name: <span class="label label-info">TestAction</span></p>
                        <p>Description: <span class="label label-info">A basic test action</span></p>
                        <p>Permissions: <span class="label label-info">No permissions required</span></p>
                        Parameters:
                        <table class="table table-bordered table-hover table-striped">
                            <tr>
                                <th>Name</th>
                                <th>Type</th>
                                <th>Values</th>
                            </tr>
                            <tr>
                                <td>actionName</td>
                                <td>String</td>
                                <td>TestAction</td>
                            </tr>
                        </table>
                        <h3>Request:</h3>
                    <pre>{
actionName : TestAction
}</pre>
                        <h3>Responses:</h3>
                        <h4>Ok</h4>
                    <pre>{
type : OK
}</pre>
                        <h4>Error response</h4>
                    <pre>{
type : Error
message.key : a error key
message : a error message
}</pre>
                    </div>
                </div>
            </div>
            <div class="tab-pane fade" id="subfolder">
                <div class="row-fluid">
                    <div class="span12">
                        <h2>Action</h2>
                        <p>Name: <span class="label label-info">SubFolderParserImport</span></p>
                        <p>Description: <span class="label label-info">A basic test action</span></p>
                        <p>Permissions: <span class="label label-info">CREATE_PLAYLIST</span></p>
                        Parameters:
                        <table class="table table-bordered table-hover table-striped">
                            <tr>
                                <th>Name</th>
                                <th>Type</th>
                                <th>Values</th>
                            </tr>
                            <tr>
                                <td>actionName</td>
                                <td>String</td>
                                <td>SubFolderParserImport</td>
                            </tr>
                            <tr>
                                <td>userName</td>
                                <td>String</td>
                                <td></td>
                            </tr>
                            <tr>
                                <td>passHash</td>
                                <td>String</td>
                                <td>SHA512HEX Hash of the user password</td>
                            </tr>
                        </table>
                        <h3>Request:</h3>
                        <pre>{
    actionName : SubFolderParserImport
    userName : user
    passHash : 6c1fe0650107843f91e5040409283b094f760fa258dadae221579803493a188a5b6b44510cd1a4e2cd3b749a0a4696642f60bec8fc8bc640953417f3463ba0e9
    }</pre>
                        <h3>Responses:</h3>
                        <h4>Response if login was successful</h4>
                        <pre>{
    type : OK
    sessionID : 3b409e60-83eb-11e2-9e96-0800200c9a66
    }</pre>
                        <h4>Response with all permissions</h4>
                        <pre>{
    type : OK
    oneList : {CREATE_PLAYLIST, MODIFY_PLAYLIST}
    }</pre>
                        <h4>Error response</h4>
                        <pre>{
    type : Error
    message.key : a error key
    message : a error message
    }</pre>
                    </div>
                </div>
            </div>
    </div>
    </div>
</div>
<script src="./help/js/jquery.js"></script>
<script src="./help/js/bootstrap.js"></script>
<script src="./help/js/prettify.js"></script>
<script src="./help/js/run_prettify.js"></script>
</body>
</html>
